

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Installing oBB &mdash; oBB Documentation</title>
  

  
  
    <link rel="shortcut icon" href="_static/favicon.ico"/>
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="oBB Documentation" href="index.html"/>
        <link rel="next" title="User Guide" href="userguide.html"/>
        <link rel="prev" title="Overlapping Branch and Bound" href="index.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> oBB
          

          
          </a>

          
            
            
              <div class="version">
                0.8b
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installing oBB</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation-using-pip">Installation using pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="#manual-installation">Manual installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#uninstallation">Uninstallation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="userguide.html">User Guide</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">oBB</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          

 



<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
    <li>Installing oBB</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/install.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="installing-obb">
<h1>Installing oBB<a class="headerlink" href="#installing-obb" title="Permalink to this headline">¶</a></h1>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>oBB requires the following software to be installed:</p>
<ul class="simple">
<li><a class="reference external" href="http://www.python.org/">Python 2.6/2.7 or Python 3</a></li>
<li>A working implementation of MPI-2 (e.g. <a class="reference external" href="http://www.open-mpi.org/">OpenMPI</a> or <a class="reference external" href="http://www.mpich.org/">MPICH</a>)</li>
</ul>
<p>Additionally, the following python packages should be installed (these will be installed automatically if using <a class="reference external" href="http://www.pip-installer.org/">pip</a>, see <a class="reference internal" href="#installation-using-pip">Installation using pip</a>):</p>
<ul class="simple">
<li><a class="reference external" href="http://www.numpy.org/">NumPy 1.3.0 or higher</a></li>
<li><a class="reference external" href="http://mpi4py.scipy.org/">MPI for Python 1.3 or higher</a></li>
<li><a class="reference external" href="http://cvxopt.org/">CVXOPT 1.1.3 or higher</a></li>
</ul>
<p>Optionally, <a class="reference external" href="http://www.matplotlib.org/">matplotlib 1.1.0 or higher</a> may be manually installed for visualising the algorithm in 2D.</p>
</div>
<div class="section" id="installation-using-pip">
<h2>Installation using pip<a class="headerlink" href="#installation-using-pip" title="Permalink to this headline">¶</a></h2>
<p>For easy installation, use <a class="reference external" href="http://www.pip-installer.org/">pip</a> as root:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ <span class="o">[</span>sudo<span class="o">]</span> pip install --pre obb
</pre></div>
</div>
</div></blockquote>
<p>or alternatively <em>easy_install</em>:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ <span class="o">[</span>sudo<span class="o">]</span> easy_install obb
</pre></div>
</div>
</div></blockquote>
<p>If you do not have root privileges or you want to install oBB for your private use, you can use:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ pip install --pre --user obb
</pre></div>
</div>
</div></blockquote>
<p>which will install oBB in your home directory.</p>
<p>Note that if an older install of oBB is present on your system you can use:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ <span class="o">[</span>sudo<span class="o">]</span> pip install --pre --upgrade obb
</pre></div>
</div>
</div></blockquote>
<p>to upgrade oBB to the latest version.</p>
</div>
<div class="section" id="manual-installation">
<h2>Manual installation<a class="headerlink" href="#manual-installation" title="Permalink to this headline">¶</a></h2>
<p>Alternatively, you can download the source code and unpack as follows:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ wget http://pypi.python.org/packages/source/o/oBB/oBB-X.X.tar.gz
$ tar -xzvf oBB-X.X.tar.gz
$ <span class="nb">cd</span> oBB-X.X
</pre></div>
</div>
</div></blockquote>
<p>and then build and install manually using:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ python setup.py build
$ <span class="o">[</span>sudo<span class="o">]</span> python setup.py install
</pre></div>
</div>
</div></blockquote>
<p>If you do not have root privileges or you want to install oBB for your private use, you can use:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ python setup.py install --user
</pre></div>
</div>
</div></blockquote>
<p>instead.</p>
</div>
<div class="section" id="testing">
<h2>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h2>
<p>oBB includes a command line test script to check that the installation was successfull. To run the test simply type the following into your shell:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ test_obb
</pre></div>
</div>
</div></blockquote>
<p>This will run oBB using MPI on one processor core for a simple 2D sum of sines problem (see <a class="reference external" href="userguide.html#example-of-use">Example of Use</a>).</p>
<p>Note that if using the MPICH implementation of MPI you first need to start an mpd daemon in the background:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ mpd <span class="p">&amp;</span>
</pre></div>
</div>
</div></blockquote>
<p>but this is not necessary for other MPI implementations, e.g. OpenMPI.</p>
</div>
<div class="section" id="uninstallation">
<h2>Uninstallation<a class="headerlink" href="#uninstallation" title="Permalink to this headline">¶</a></h2>
<p>If oBB was installed using <a class="reference external" href="http://www.pip-installer.org/">pip</a> you can uninstall as follows:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>$ <span class="o">[</span>sudo<span class="o">]</span> pip uninstall obb
</pre></div>
</div>
</div></blockquote>
<p>If oBB was installed manually you have to remove the installed files by hand (located in your python site-packages directory).</p>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="userguide.html" class="btn btn-neutral float-right" title="User Guide" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="index.html" class="btn btn-neutral" title="Overlapping Branch and Bound" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, J. M. Fowkes.
      Last updated on 18 Jul, 2016.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'0.8b',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>